Update artifact-handlers.apt #1466
Conversation
Clarify that the extension used outside repositories for pom files usually differs
|
Am unsure is it meaningful at all to speak about artifacts "outside of repository"... |
|
Well for me extension is mostly connected to files used outside a repo, and this is the only type where in repo and outside repo extension differs. |
| @@ -35,7 +35,7 @@ Default Artifact Handlers Reference | |||
| *--------------------+---------------+------------+------------+-----------+---------------------+-----------------------+ | |||
| || type || classifier || extension || packaging || language || added to classpath || includesDependencies || | |||
| *--------------------+---------------+------------+------------+-----------+---------------------+-----------------------+ | |||
| | <<<pom>>> | | <= type> | <= type> | none | | | | |||
| | <<<pom>>> | | <= type>, Note: this differs for POM files outside the repository which usually use <<<xml>>> as filesystem extension. | <= type> | none | | | | |||
There was a problem hiding this comment.
I would appreciate a more helpful criticism!
There was a problem hiding this comment.
sorry, we had so many discussions that I don't see how to tell.
as said by Tamasz, there is a mix
In addition, such a text will break the table display.
eventually, if you absolutely want to write something, you can add a note at the end of the page that could say something like:
Dependency type <<<pom>>> has an extension <<<.pom>>> because POM is stored in repositories as <<<artifactId-version.pom>>>.
During development, as stored in source control, the POM file is by default named <<<pom.xml>>>: it will be renamed during install/deploy to be later eventually used as a pom dependency
I don't see how useful it is, but it says what you seem to need to say and does not break the dependency type table
|
what people need to understand is that artifact handler is for a dependency, not for a file anywhere outside of repo, any file can have any extension: call the file as you wish |
|
How are people supposed to know the extension of a dependency? Although admittedly rarely necessary, this is important if you use resolver API directly. |
|
The dependency extension is told by type. Dependency is never "anywhere on disk", it may come from repo only. You mix few things here... |
|
When you deploy/install artifacts to a repo they come from a file with an extension. Usually this extension is the same as being used inside the repo except for POM! |
|
The depensency extension is told by type. Deoendency is never "anywhere on disk", it may come from repo only. You mix few things here... |
|
Wrong, for example signatures are also tmp files, getting their "final form" only at deploy |
|
Recognizing (or assuming) anything about not yet installed/deployed artifact is wrong, as producer may also use anything, like tmp file. It is artifact that you need to inspect, not the backing file. |
|
No consensus here, therefore closing. |
Clarify that the extension used outside repositories for pom files usually differs
Following this checklist to help us incorporate your
contribution quickly and easily:
for the change (usually before you start working on it). Trivial changes like typos do not
require a JIRA issue. Your pull request should address just this issue, without
pulling in other changes.
[MNG-XXX] SUMMARY,where you replace
MNG-XXXandSUMMARYwith the appropriate JIRA issue.[MNG-XXX] SUMMARY.Best practice is to use the JIRA issue title in both the pull request title and in the first line of the commit message.
mvn clean verifyto make sure basic checks pass. A more thorough check willbe performed on your pull request automatically.
If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.
I hereby declare this contribution to be licenced under the Apache License Version 2.0, January 2004
In any other case, please file an Apache Individual Contributor License Agreement.